|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An instance of ICommandManager
can be used to obtain
instances of ICommand
, as well as manage whether or not
those instances are active or inactive, enabled or disabled.
This interface is not intended to be extended or implemented by clients.
EXPERIMENTAL
CommandManagerFactory
,
ICommand
,
ICommandManagerListener
Method Summary | |
void |
addCommandManagerListener(ICommandManagerListener commandManagerListener)
Registers an instance of ICommandManagerListener to
listen for changes to attributes of this instance. |
Set |
getActiveActivityIds()
TODO javadoc |
String |
getActiveKeyConfigurationId()
TODO javadoc |
String |
getActiveLocale()
TODO javadoc |
String |
getActivePlatform()
TODO javadoc |
ICategory |
getCategory(String categoryId)
Returns a handle to a category given an identifier. |
ICommand |
getCommand(String commandId)
Returns a handle to a command given an identifier. |
Set |
getDefinedCategoryIds()
Returns the set of identifiers to defined categories. |
Set |
getDefinedCommandIds()
Returns the set of identifiers to defined commands. |
Set |
getDefinedKeyConfigurationIds()
Returns the set of identifiers to defined key configurations. |
IKeyConfiguration |
getKeyConfiguration(String keyConfigurationId)
Returns a handle to a key configuration given an identifier. |
Map |
getPartialMatches(KeySequence keySequence)
TODO javadoc |
String |
getPerfectMatch(KeySequence keySequence)
TODO javadoc |
boolean |
isPartialMatch(KeySequence keySequence)
TODO javadoc |
boolean |
isPerfectMatch(KeySequence keySequence)
TODO javadoc |
void |
removeCommandManagerListener(ICommandManagerListener commandManagerListener)
Unregisters an instance of ICommandManagerListener
listening for changes to attributes of this instance. |
void |
setActiveActivityIds(Set activeActivityIds)
Sets the set of identifiers to active activities. |
void |
setActiveKeyConfigurationId(String activeKeyConfigurationId)
TODO javadoc |
void |
setActiveLocale(String activeLocale)
TODO javadoc |
void |
setActivePlatform(String activePlatform)
TODO javadoc |
Method Detail |
public void addCommandManagerListener(ICommandManagerListener commandManagerListener)
ICommandManagerListener
to
listen for changes to attributes of this instance.
commandManagerListener
- the instance of ICommandManagerListener
to
register. Must not be null
. If an attempt is
made to register an instance of ICommandManagerListener
which is already registered with this instance, no operation
is performed.public Set getActiveActivityIds()
public String getActiveKeyConfigurationId()
public String getActiveLocale()
public String getActivePlatform()
public ICategory getCategory(String categoryId)
categoryId
- an identifier. Must not be null
public ICommand getCommand(String commandId)
commandId
- an identifier. Must not be null
public Set getDefinedCategoryIds()
Returns the set of identifiers to defined categories.
Notification is sent to all registered listeners if this attribute changes.
null
. If this
set is not empty, it is guaranteed to only contain instances of
String
.public Set getDefinedCommandIds()
Returns the set of identifiers to defined commands.
Notification is sent to all registered listeners if this attribute changes.
null
. If this
set is not empty, it is guaranteed to only contain instances of
String
.public Set getDefinedKeyConfigurationIds()
Returns the set of identifiers to defined key configurations.
Notification is sent to all registered listeners if this attribute changes.
null
.
If this set is not empty, it is guaranteed to only contain
instances of String
.public IKeyConfiguration getKeyConfiguration(String keyConfigurationId)
keyConfigurationId
- an identifier. Must not be null
public Map getPartialMatches(KeySequence keySequence)
public String getPerfectMatch(KeySequence keySequence)
public boolean isPartialMatch(KeySequence keySequence)
public boolean isPerfectMatch(KeySequence keySequence)
public void removeCommandManagerListener(ICommandManagerListener commandManagerListener)
ICommandManagerListener
listening for changes to attributes of this instance.
commandManagerListener
- the instance of ICommandManagerListener
to
unregister. Must not be null
. If an attempt
is made to unregister an instance of ICommandManagerListener
which is not already registered with this instance, no
operation is performed.public void setActiveActivityIds(Set activeActivityIds)
activeActivityIds
- the set of identifiers to active activities. This set may be
empty, but it must not be null
. If this set
is not empty, it must only contain instances of String
.public void setActiveKeyConfigurationId(String activeKeyConfigurationId)
public void setActiveLocale(String activeLocale)
public void setActivePlatform(String activePlatform)
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |